home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d10 / infoselt.arc / SWAPIS.DOC < prev    next >
Text File  |  1990-11-11  |  14KB  |  325 lines
  1.  
  2.                          The SWAP Utilities(TM)
  3.  
  4.                              Version 1.55
  5.  
  6.                        SWAPIS(TM) -- For Info Select
  7.  
  8. The SWAP Utilities(TM) and this Documentation are:
  9.  
  10. Copyright 1989, Innovative Data Concepts
  11. All Rights Reserved.
  12.  
  13.  
  14. This document; other accompanying written and disk-based notes and 
  15. specifications; and all referenced and related program files accompanying 
  16. this document are copyrighted by Innovative Data Concepts.
  17.  
  18. TRADEMARKS
  19.  
  20. SWAPIS and The SWAP Utilities are trademarks of Innovative Data Concepts.
  21. Info Select is a trademark of Micro Logic Corp.
  22.  
  23. WHAT THE SWAP UTILITIES DO
  24.  
  25. The SWAP Utilities intercept certain DOS calls made by ram-resident
  26. applications, and "swap" the entire resident portion of the application 
  27. to extended or expanded memory, or to disk files.  
  28. This will greatly decrease the amount of "real" RAM needed to load
  29. Info Select.
  30.  
  31. If swapping goes to disk, two swapfiles are created in the drive and 
  32. directory specified with command line option /D or the TEMP environment 
  33. variable.  A third swapfile is created on disk no matter what swapping 
  34. method you have selected.
  35.  
  36. INSTALLATION
  37.  
  38. Just copy SWAPIS.COM into the same directory that IS.EXE is located in.
  39. No further installation is necessary.
  40.  
  41. -DESQview
  42.  
  43. In order to successfully use SWAPIS with DESQview, you must run 
  44. TESTDV.COM first.  
  45.  
  46. Copy TESTDV.COM and T2-PIF.DVP into your DESQview directory. If you 
  47. already have a T2-PIF.DVP, re-name the one provided with SWAPIS to a 
  48. different filename.  Select Add a Program, and add the "SWAP Utilities 
  49. Configuration" to your program list.  Then, open the window, jot down 
  50. the options specified by TESTDV, and add them to your SWAPIS command 
  51. line(s).
  52.  
  53. Once you run this program, it is only needed again if you change the TSRs 
  54. that you load globally with DV.
  55.  
  56. IMPORTANT NOTE!!  Unless you have QEMM 5.x and a DESQview version later
  57. than 2.26 on 386 machines, you will be unable to pop up SWAPIS if you have 
  58. a DV window open with "Virtualize Text and Graphics" set to "y".  This 
  59. is because DV uses the 386 "virtual 86" mode to virtualize the video 
  60. screen, and  does not provide any way (short of adding a 386 memory 
  61. manager to SWAP??) to gain control.
  62.  
  63. LOADING AND USING SWAPIS
  64.  
  65. There are two ways to load SWAPIS -- from the command-line, or from a 
  66. batch file.  By default, SWAPIS assumes you will be starting it from the
  67. DOS command-line, and automatically adds the appropriate keystroke sequences
  68. to the keyboard buffer to load your application.
  69.  
  70.  
  71. -Loading from the Command Line
  72.  
  73. When loading from the DOS command line, use the following syntax:
  74.  
  75.                          SWAPIS <command line options>
  76.  
  77. When loaded from the command line, the SWAP utility will load your
  78. application for you.
  79.  
  80.  
  81. -Loading from a Batch File
  82.  
  83. If you load SWAPIS from a batch file, you must use the /N command line option
  84. (described below), followed by an immediate load of your application.  For
  85. example:
  86.  
  87. File STARTIS.BAT:
  88.  
  89. CD \IS
  90. SWAPIS /N
  91. IS 99
  92. CD \
  93.  
  94. When using the /N switch, you must load the application yourself.  SWAPIS
  95. will not respond to the hotkey until the application has been loaded.
  96.  
  97. Once SWAPIS and Info Select have been loaded into memory, SWAPIS will 
  98. display a message stating it has successfully loaded the application, 
  99. and give an actual report of memory available. This memory value
  100. is in Kilobytes, so multiply by 1024 to get actual bytes free.  
  101.  
  102. The display will also tell you what kind of memory was used for the swapping;
  103. extended memory, expanded memory, or disk virtual memory.  If for any reason
  104. SWAPIS unable to correctly swap out the application, a message will be 
  105. displayed notifying you of that occurrence, and both SWAPIS and Info Select
  106. will be removed from memory.
  107.  
  108.  
  109. -Command Line Options
  110.  
  111.  /H /? ? -- Display a help screen
  112.  /N      -- When used in a batch file 
  113.  /U      -- Remove SWAP?? and application from RAM
  114.  /Dpath  -- FULL PATHNAME to store swap files on (if not enough
  115.             EMS is present)
  116.  /Sx     -- Set Swapping type (0=Auto, 1=Disk, 2=EMM, 3=XMS)
  117.             SwapType = 0 is the default; if selected type fails (i.e.,no XMS 
  118.             is available with /S3), auto-check is done.
  119.  /Tx     -- Pasting Throttle (0=slow, 1=medium, 2=fast, 3=compat) [default=2] 
  120.  /V      -- Special DESQview Options 
  121.  
  122. To set the hotkey
  123.     /A -- Use Alt-Key for hotkey shift state
  124.     /C -- Use Ctl-Key for hotkey shift state
  125.     /L -- Use Left-Shift-Key for hotkey shift state
  126.     /R -- Use Right-Shift-Key for hotkey shift state
  127.   /Kxx -- Scan code for hotkey to use (see chart in documentation)
  128.             requires two HEX digits following the /K
  129.  
  130.  
  131. SWAPIS automatically defaults to the Alt-J hotkey.  Do not use any 
  132. command-line options for Info Select to change the hotkey -- use the SWAPIS
  133. options instead.
  134.  
  135. -Explanation of Command Line Options
  136.  
  137. /N -- If the /N switch is used, The SWAP utility will not automatically place
  138. the appropriate keystroke combination to load the application into  the
  139. keyboard buffer when it goes resident.  This option must be used when loading
  140. The SWAP Utilities from a batch file.
  141.  
  142. /U -- Use this option to cleanly remove SWAP?? and your application from RAM. 
  143. If disk swapping is in use, the swap files will be deleted before freeing 
  144. memory.  If the application also uses expanded memory, it will be freed as
  145. well.  If the application uses disk-based swap files (such as those SideKick
  146. Plus uses) they will not be deleted.  
  147.  
  148. Do not attempt to use the Info Select "unload" feature.  Use the /U feature 
  149. of the SWAP utility instead.
  150.  
  151. /Sx -- The /S parameter determines the type of swapping to use.  In the
  152. default Autodetect mode, The SWAP Utility will attempt to allocated expanded 
  153. memory, using EMS version level 3.2 or later.  If EMS is not available, the 
  154. utility will attempt to use Extended Memory that is available, using 
  155. Microsoft's eXtended Memory Specification (XMS) (See note about XMS below).
  156. If neither EMS or XMS is available, two swap files will  be created, and 
  157. SWAP?? will use disk (default, C:\) for swapping.  The /S  parameter can 
  158. be used to override the default mode, and force swapping to  XMS, EMS 
  159. or Disk.  If the swapping method specified with /S is not valid, then Auto 
  160. mode is used.  Note that the third swapfile (SWAP??.SW3) is created in the 
  161. path specified by the /D parameter, or the TEMP environment variable, no 
  162. matter what swapping method is chosen.  
  163.  
  164. /Dpath -- The /D parameter tells the SWAP utility in what drive and directory 
  165. to store  the swap files.  The default is the root directory on drive C
  166. (C:\).  The pathname is limited to 30 characters, and must contain a  valid
  167. drive specification, and path.  The trailing backslash is not necessary. 
  168. If the /D parameter is not the last option on the command-line, there must 
  169. be a space character following the pathname and before another slash option.
  170. Note that at least one disk-based swap file will always be created on this 
  171. path.  An example path is: /DC:\TEMP
  172.  
  173. /Tx -- This option may be used to "throttle" down the pasting speed of the
  174. SWAP utility you are using.  Some applications, such as the Norton Editor,
  175. cannot handle characters as fast as SWAP?? can feed them, requiring a slower
  176. speed to be used.  The valid values here are 0, 1, 2 or, ranging  from
  177. slowest (0) to fastest (2).  The /T3 switch is for "compatibility" mode.  Use
  178. this switch if you are using a program that relocates the BIOS keyboard
  179. buffer, or expands the keyboard type-ahead buffer.  This is the slowest
  180. option, but pasting will work in all cases.  The default is fast (/T2).
  181.  
  182. Selecting Hot Keys
  183.  
  184. The SWAP Utilities allow the use of more hotkeys than most applications do;
  185. for example, they will accept F11 (/K57), or Ctl-LShift-Q (/C /L /K10).   The
  186. following table can be used to determine the scan codes of the key you  wish
  187. to use with the /K parameter; this is not a complete table, it is intended
  188. simply as a guide:
  189.  
  190.  KEY      CODE     KEY      CODE
  191. ---------------------------------
  192.   A        1E       B        30
  193.   C        2E       D        20
  194.   E        12       F        21
  195.   G        22       H        23
  196.   I        17       J        24
  197.   K        25       L        26
  198.   M        32       N        31
  199.   O        18       P        19
  200.   Q        10       R        13
  201.   S        1F       T        14
  202.   U        16       V        2F
  203.   W        11       X        2D
  204.   Y        15       Z        2C
  205.   0        0b       1        02
  206.   2        03       3        04
  207.   4        05       5        06
  208.   6        07       7        08
  209.   8        09       9        0A
  210.   -        0C       =        0D
  211.   F1       3B       F2       3C
  212.   F3       3D       F4       3E
  213.   F5       3F       F6       40
  214.   F7       41       F8       42
  215.   F9       43       F10      44
  216.   F11      57       F12      58
  217.  
  218.  
  219. -Sample Command Lines
  220.  
  221.  SWAPIS /K58 /T1 /S1 /DE:\
  222.  
  223. This command would load SWAPIS, swapping to the root directory of drive E:,
  224. using a hotkey of F12, and a paste speed of medium.
  225.  
  226.  SWAPIS /l/a/k25/df:\swappath
  227.  
  228. This would load SWAPIS, swapping to EMS if available, otherwise to
  229. F:\SWAPPATH, with a hotkey of Left-Shift-Alt-K.
  230.  
  231.  SWAPIS /dD:\ /A/k14/S1
  232.  
  233. This would load SWAPIS, swapping to D:\, with a hotkey of Alt-T. 
  234.  
  235.  
  236. -Extended Memory
  237.  
  238. In order to use extended memory with SWAPIS, you must use a driver that 
  239. supports Microcoft's "eXtended Memory Specification (XMS), ver 2.0", such 
  240. as Microsoft's HIMEM.SYS.  The current versions of 386MAX and QEMM (versions
  241. later than 5.0) both support XMS on 386 machines; alternatively, the 
  242. latest official XMS driver may be gotten free from Microsoft, either through 
  243. their Compuserve Forum (GO MSSYS), or by calling Microsoft customer service 
  244. at (800)426-9400 and ask for a copy of the "XMS Specification and it's supplemental diskette."
  245.  
  246. Please note that if your computer supports both XMS and EMS, EMS memory is
  247. the preferred choice; using XMS requires almost twice the amount of memory.
  248.  
  249.  
  250. IMPORTANT NOTES
  251.  
  252.  
  253. -General Notes
  254.  
  255. If you are swapping to disk, two swapfiles are created in the specified drive
  256. and directory.  A third swapfile is created no matter what swapping method 
  257. you have selected.  
  258.  
  259. These swapfiles must not be deleted while the SWAP utility is loaded.  Doing
  260. so will cause your machine to crash if you attempt to popup!
  261.  
  262. You must load The SWAP Utilities after all network drivers, disk cache
  263. programs, and other programs that require background processing.  With these
  264. exceptions, load order is not important.  You can load The SWAP Utilities at
  265. any point, early or late in your TSR order.  You can also load The SWAP
  266. Utilities in extra, or 'high' DOS memory with 386Max(TM) or QEMM-386(TM).  
  267.  
  268. You may safely load a SWAP utility inside a Software Carousel(TM) partition, 
  269. or as a global SC utility.  You may notice a period of a blank screen when
  270. attempting to swap partitions after having used a SWAP utility, but be
  271. patient, and the partition will change normally.
  272.  
  273. When pasting large blocks into an application, you will occasionally see a
  274. "hiccup" with the SWAP message on the display -- this is caused by swapping
  275. your aplication in and out, to read the next set of keys.  Most applications
  276. support virtually unlimited paste buffers, and the memory used by the SWAP
  277. utilities is limited.
  278.  
  279. In general, do not attempt to use a particular application's "unload" or
  280. "remove from memory" feature.  It won't work, and will in all likelihood
  281. crash your machine.  Use the /U feature of the SWAP utility instead.
  282.  
  283. When creating swap files for disk-based swapping, the SWAP utilities default
  284. to the root directory of Drive C:.  If you create an environment string
  285. called TEMP with the SET command, the utilities will instead default to the
  286. directory specified by that command, and the use of /D will not be necessary. 
  287. An example of setting an environment string would be:
  288.  
  289.    SET TEMP=G:\
  290.  
  291. where G is a fast RAM disk.  This would cause disk-swapping  to take place
  292. in the root directory of Drive G:.  The environment variable TEMP must, of
  293. course, be set prior to loading your SWAP utility.  The programs will
  294. attempt to swap in the following sequence: 1) Try to swap to  EMS; 2) If /D
  295. specified, try to swap to specified path; 3) Try to find environment variable
  296. named "TEMP" and if it exists, swap to the specified path; 4) Try to swap to
  297. the root directory of Drive C:; or, 5) abort, and remove both the application
  298. and the SWAP utility from memory.
  299.  
  300.  
  301. -Note for Microsoft Word Users:
  302.  
  303. When using The SWAP Utilities with Microsoft Word, you should not use the /G
  304. switch, even if you plan to use Word in graphics modes.  The SWAP Utilities
  305. automatically detect the presence of MS Word 4.0 and 5.0, and will switch
  306. between text and graphics modes as needed.  This switch works on CGA, EGA
  307. VGA and Hercules systems with Word 4.0, except in Hercules 90x43 mode.
  308.  
  309. Word 5.0 users who work in graphics mode will need to do an extra bit of
  310. setup.  In order for the switch between text and graphics to work, you
  311. must set both text and graphic display modes in the Word 5.0 Options menu.
  312. Load Word 5.0, and bring up the Options menu.  Select the appropriate
  313. text display mode for your system.  Return immediately to the Options
  314. menu, and now select the graphics display mode you wish to work in.
  315. Test the results by pressing Alt-F9, to toggle between text and
  316. graphics modes.  Exit from Word, and you're all set!
  317.  
  318. -Specific Notes
  319.  
  320. You will not be able to load Info Select using the "repeat" option.
  321.  
  322. If you do not use the /N switch, SWAPIS will load Info Select as "IS".
  323.  
  324.  
  325.